<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>console.interactive</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="console-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/console/">console</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="console-module.html">Package&nbsp;console</a> ::
        Module&nbsp;interactive
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="console.interactive-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="console.interactive-module.html">Module console.interactive</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment"># console.interactive</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-comment"># Copyright (C) 2010 Tactical Network Solutions</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-comment"># Author: Peter Eacmen &lt;peacmen@tacnetsol.com&gt;</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-comment"># URL: &lt;http://tacnetsol.com&gt;</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-comment"># $Id: interactive.py 2 2010-11-29 13:48:00 -0400 bbengfort $</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-docstring">Framework for creating command line programs with an interactive prompt. </tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-docstring">Quick Start</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-docstring">===========</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-docstring">This module contains the base classes for creating interactive console programs.</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-docstring">To get started quickly, simply create commands by extending</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-docstring">L{InteractiveCommand} and overriding the methods exposed by the interface. Then</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-docstring">instantiate an L{InteractiveShell} with your customized prompt and banner. Then</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring">add instances of your L{InteractiveCommand} via L{InteractiveShell.add_command}.</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-docstring">Finally use L{InteractiveShell.run} to run the shell with your commands, and</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-docstring">presto-- you have a complete interactive console program!</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-docstring">Sample Code</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-docstring">-----------</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring">The testland quickstart example::</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring">    if __name__ == '__main__':</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-docstring">        class TestCommand(InteractiveCommand):</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-docstring">            def get_name(self):</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring">                return 'test'</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">            def get_options(self):</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">                return { 'opt1': None,</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring">                         'opt2=': 'default',</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-docstring">                         'required=': None}</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-docstring">            def handle_command(self, opts, args):</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"><tt class="py-docstring">                print 'Test command running with options:'</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring">                for k,v in opts.items( ):</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring">                    print '%s =&gt; %s' % (str(k), str(v))</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring">                </tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-docstring">                print 'Args is: %s' % args</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-docstring">                </tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-docstring">            def get_short_description(self):</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring">                return 'I am a test command hear me roar'</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring">            def get_help_message(self):</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">                return 'test --opt1=value [--opt2=value2]'</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">        tc = TestCommand( )</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring">        shell = InteractiveShell( banner='Welcome to TestLand',</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring">                               prompt=' TEST &gt;&gt;&gt; ')</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring">        shell.add_command(tc)</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">        shell.run( )</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">As you can see, it's simple to get up and running quickly with an interactive</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">console program!</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">Extending L{InteractiveCommand}</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line"><tt class="py-docstring">===============================</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line"><tt class="py-docstring">L{InteractiveCommand} is the base class for every command that you will add to</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"><tt class="py-docstring">your interactive console program. It exposes an interface by forcing you to</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"><tt class="py-docstring">ovverride its methods by raising a C{NotImplementedError} if the child class</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line"><tt class="py-docstring">relies on the super method.</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">There are no properites specifically associated with L{InteractiveCommand},</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring">but the name, description, and help text must be implemented via their</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring">associated methods. You can add any number of helper methods to your children</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"><tt class="py-docstring">class, or any number of properties to make the command function as you wish.</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-docstring">However, note that the L{InteractiveCommand.handle_command} method is entry</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"><tt class="py-docstring">point to the command. </tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"><tt class="py-docstring">Extending L{InteractiveShell}</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring">=============================</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">L{InteractiveShell} comes with built-in help and exit commands, which are</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-docstring">internal classes. While there is no real reason to extend the shell from</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line"><tt class="py-docstring">scratch, note that you cannot have access to the L{InteractiveShell._ExitCommand}</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"><tt class="py-docstring">or the L{InteractiveShell._HelpCommand} unless you override them in your own</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-docstring">L{InteractiveShell}.</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line"><tt class="py-docstring">Larger console programs should not rely on using an C{if __name__ == '__main__'}</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"><tt class="py-docstring">block to execute code, but rather should extend L{InteractiveShell} via adding</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line"><tt class="py-docstring">customized {InteractiveCommand}s as internal classes, then ensuring that they</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"><tt class="py-docstring">are added to the shell in L{InteractiveShell.__init__}. This way, all that has</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line"><tt class="py-docstring">to be put in the main method is L{InteractiveShell.run}. </tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line"><tt class="py-docstring">Module Class Hierarchy</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line"><tt class="py-docstring">======================</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"><tt class="py-docstring">G{classtree: InteractiveCommand InteractiveShell}</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">@author: U{Peter Eacmen&lt;mailto:peacmen@tacnetsol.com&gt;}</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">@organization: Tactical Network Solutions</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-docstring">@license: Open Source MIT License</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"><tt class="py-docstring">@copyright: S{copy} 2010 Tactical Network Solutions</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-docstring">@requires: Python 2.6</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"><tt class="py-docstring">@version: 1.0</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-docstring">@change: I{interactive.py 2 2010-11-29 13:48:00 -0400 bbengfort}</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line"><tt class="py-docstring">@since: 2010-11-29 17:20:39 -0400</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-docstring">@bug: Giving a short-option to the L{InteractiveShell} throws an unhandled C{getopt} error</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"><tt class="py-docstring">@todo: Implement doctests</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"><tt class="py-docstring">@todo: Implement shortopts</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line"><tt class="py-docstring">@see: U{The Tactical Network Solutions homepage&lt;http://tacnetsol.com&gt;}</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line"><tt class="py-docstring">@see: U{Google Code Project&lt;http://code.google.com/p/console/&gt;}</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"><tt class="py-docstring">@see: U{The console Wiki&lt;http://code.google.com/p/console/wiki/console&gt;}</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext en'</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-comment">## Imports </tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">getopt</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">traceback</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">readline</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">rlcompleter</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line"> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">exceptions</tt> <tt class="py-keyword">import</tt> <tt class="py-name">NotImplementedError</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line"> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line"><tt class="py-comment">## Options parsing</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line"> </tt>
<a name="get_option_dict"></a><div id="get_option_dict-def"><a name="L136"></a><tt class="py-lineno">136</tt> <a class="py-toggle" href="#" id="get_option_dict-toggle" onclick="return toggle('get_option_dict');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive-module.html#get_option_dict">get_option_dict</a><tt class="py-op">(</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-param">longopts</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_option_dict-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_option_dict-expanded"><a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring">    Utilizes C{getopt} to create a dictionary of options and values from</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-docstring">    C{sys.argv}, which should be passed as the first argument to this method.</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line"><tt class="py-docstring">    The second argument, longopts should be the long name of the option,</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line"><tt class="py-docstring">    appended with an '=' to show that a value is expected.</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line"><tt class="py-docstring">    @note: shortopts are not yet implemented</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-docstring">        &gt;&gt;&gt; fooargs = ['foo.py', '--option=bar']</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line"><tt class="py-docstring">        &gt;&gt;&gt; opts = get_option_dict(fooargs[1:], ['option=',])</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line"><tt class="py-docstring">        &gt;&gt;&gt; if 'option' in opts:</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line"><tt class="py-docstring">        ...     print 'pass'</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line"><tt class="py-docstring">        ... else:</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line"><tt class="py-docstring">        ...     print 'fail'</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line"><tt class="py-docstring">        ... </tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line"><tt class="py-docstring">        pass</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line"><tt class="py-docstring">    @param args: Arguments string to be parsed, usually C{sys.argv[1:]}</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line"><tt class="py-docstring">    @type args: C{str}</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line"><tt class="py-docstring">    @param longopts: List of option names in longform, including the '=' at the end</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line"><tt class="py-docstring">    @type longopts: C{list} of C{str}</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line"><tt class="py-docstring">    @return: Dictionary of options as keys and parsed C{sys.argv} as values</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line"><tt class="py-docstring">    @rtype: C{dict}</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line">    <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-op">}</tt>  </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line">        <tt class="py-name">opts</tt><tt class="py-op">,</tt> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-name">getopt</tt><tt class="py-op">.</tt><tt class="py-name">getopt</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">longopts</tt><tt class="py-op">)</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt> <tt class="py-name">getopt</tt><tt class="py-op">.</tt><tt class="py-name">GetoptError</tt><tt class="py-op">,</tt> <tt class="py-name">err</tt><tt class="py-op">:</tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">err</tt><tt class="py-op">)</tt> <tt class="py-comment"># will print something like "option -a not recognized"</tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line"> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">o</tt><tt class="py-op">,</tt> <tt class="py-name">a</tt> <tt class="py-keyword">in</tt> <tt class="py-name">opts</tt><tt class="py-op">:</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt>  <tt class="py-line">        <tt class="py-name">result</tt><tt class="py-op">[</tt><tt class="py-name">o</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">a</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line"> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line"> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line"><tt class="py-comment">## Interactive Command &amp; Command Prompt Helpers</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line"> </tt>
<a name="InteractiveCommand"></a><div id="InteractiveCommand-def"><a name="L178"></a><tt class="py-lineno">178</tt> <a class="py-toggle" href="#" id="InteractiveCommand-toggle" onclick="return toggle('InteractiveCommand');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="console.interactive.InteractiveCommand-class.html">InteractiveCommand</a><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveCommand-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InteractiveCommand-expanded"><a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line"><tt class="py-docstring">    Base class for all commands to be added to the Interactive Shell. This is</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line"><tt class="py-docstring">    essentially an empty shell class that provides an interface to methods that</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line"><tt class="py-docstring">    must be implemented for all children. If not implemented, a</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line"><tt class="py-docstring">    C{NotImplementedError} is raised. </tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line"> </tt>
<a name="InteractiveCommand.get_name"></a><div id="InteractiveCommand.get_name-def"><a name="L186"></a><tt class="py-lineno">186</tt> <a class="py-toggle" href="#" id="InteractiveCommand.get_name-toggle" onclick="return toggle('InteractiveCommand.get_name');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveCommand-class.html#get_name">get_name</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveCommand.get_name-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveCommand.get_name-expanded"><a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line"><tt class="py-docstring">        Getter method for the name of the command- by implementing this method,</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line"><tt class="py-docstring">        you will set the command name utilized by L{InteractiveShell}. This</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line"><tt class="py-docstring">        prevents use of a named attribute for the class. </tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line"><tt class="py-docstring">        Usage: C{return 'name'}</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line"><tt class="py-docstring">        @return: The name of the command</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{str}</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">,</tt> <tt class="py-string">'Must implement'</tt> </tt>
</div><a name="L198"></a><tt class="py-lineno">198</tt>  <tt class="py-line"> </tt>
<a name="InteractiveCommand.get_options"></a><div id="InteractiveCommand.get_options-def"><a name="L199"></a><tt class="py-lineno">199</tt> <a class="py-toggle" href="#" id="InteractiveCommand.get_options-toggle" onclick="return toggle('InteractiveCommand.get_options');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveCommand-class.html#get_options">get_options</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveCommand.get_options-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveCommand.get_options-expanded"><a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line"><tt class="py-docstring">        Getter method for the options that manipulate the execution of the</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line"><tt class="py-docstring">        command. By implementing this method you will set the options of the</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line"><tt class="py-docstring">        command that are parsed by the interpreter.</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line"><tt class="py-docstring">        The options dictionary is constructed with the name of the option (the</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line"><tt class="py-docstring">        longopt format is the default) as the key. If the option is a flag or</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line"><tt class="py-docstring">        required, then set the value to C{None}, else, set it to the default</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line"><tt class="py-docstring">        value. If the option takes an argument, ensure '=' is appended to the</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line"><tt class="py-docstring">        option name. </tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line"><tt class="py-docstring">        Usage: C{return {'opt1': None, 'opt2=': 'default', 'required=': None}}</tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line"><tt class="py-docstring">        @return: The options dictionary, constructed as described above.</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{dict}</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">,</tt> <tt class="py-string">'Must implement'</tt> </tt>
</div><a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line"> </tt>
<a name="InteractiveCommand.handle_command"></a><div id="InteractiveCommand.handle_command-def"><a name="L218"></a><tt class="py-lineno">218</tt> <a class="py-toggle" href="#" id="InteractiveCommand.handle_command-toggle" onclick="return toggle('InteractiveCommand.handle_command');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveCommand-class.html#handle_command">handle_command</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">opts</tt><tt class="py-op">,</tt> <tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveCommand.handle_command-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveCommand.handle_command-expanded"><a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line"><tt class="py-docstring">        Called by L{InteractiveShell} when it recieves the name of the command,</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line"><tt class="py-docstring">        identified by L{get_name}. This method is essentially the worker task of</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt>  <tt class="py-line"><tt class="py-docstring">        the command and is the entrance point for specific program logic.</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line"><tt class="py-docstring">        @param opts: The result of L{get_option_dict}, whose keys are taken from L{get_options}</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line"><tt class="py-docstring">        @type opts: C{dict}</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line"><tt class="py-docstring">        @param args: The raw string passed to the command, useful for debugging or capturing non-option args</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line"><tt class="py-docstring">        @type args: C{str}</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">,</tt> <tt class="py-string">'Must implement'</tt> </tt>
</div><a name="L230"></a><tt class="py-lineno">230</tt>  <tt class="py-line"> </tt>
<a name="InteractiveCommand.get_short_description"></a><div id="InteractiveCommand.get_short_description-def"><a name="L231"></a><tt class="py-lineno">231</tt> <a class="py-toggle" href="#" id="InteractiveCommand.get_short_description-toggle" onclick="return toggle('InteractiveCommand.get_short_description');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveCommand-class.html#get_short_description">get_short_description</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveCommand.get_short_description-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveCommand.get_short_description-expanded"><a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt>  <tt class="py-line"><tt class="py-docstring">        Getter method for the short description of the command. Usually just a</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line"><tt class="py-docstring">        brief sentence about what the command will do, and what it expects.</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line"><tt class="py-docstring">        @note: Called by L{InteractiveShell} C{help} command, which lists all</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line"><tt class="py-docstring">        available commands and their descriptions. </tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line"><tt class="py-docstring">        @return: A short description of the command and what it does</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{str}</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-string">'No description'</tt> </tt>
</div><a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line">     </tt>
<a name="InteractiveCommand.get_help_message"></a><div id="InteractiveCommand.get_help_message-def"><a name="L244"></a><tt class="py-lineno">244</tt> <a class="py-toggle" href="#" id="InteractiveCommand.get_help_message-toggle" onclick="return toggle('InteractiveCommand.get_help_message');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveCommand-class.html#get_help_message">get_help_message</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveCommand.get_help_message-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveCommand.get_help_message-expanded"><a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line"><tt class="py-docstring">        Getter method for the usage and instruction of using a command. This is</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line"><tt class="py-docstring">        a longer docstring that describes the command, the operation of the</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line"><tt class="py-docstring">        command, usage instructions, and all available options and arguments the</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line"><tt class="py-docstring">        command will take.</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line"><tt class="py-docstring">        @note: Called by L{InteractiveShell} C{help command} -- returns the</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line"><tt class="py-docstring">        specific usage instructions for C{command}</tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line"><tt class="py-docstring">        @return: The long description of the command including usage and arguments.</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{docstr}</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-string">'No help available'</tt> </tt>
</div></div><a name="L258"></a><tt class="py-lineno">258</tt>  <tt class="py-line"> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line"> </tt>
<a name="CustomCompleter"></a><div id="CustomCompleter-def"><a name="L260"></a><tt class="py-lineno">260</tt> <a class="py-toggle" href="#" id="CustomCompleter-toggle" onclick="return toggle('CustomCompleter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="console.interactive.CustomCompleter-class.html">CustomCompleter</a><tt class="py-op">(</tt><tt class="py-base-class">rlcompleter</tt><tt class="py-op">.</tt><tt class="py-base-class">Completer</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CustomCompleter-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="CustomCompleter-expanded"><a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt>  <tt class="py-line"><tt class="py-docstring">    A custom implementation of global_matches from the rlcompleter module that</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line"><tt class="py-docstring">    will NOT use __builtin__.__dict__ and python language keywords for</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line"><tt class="py-docstring">    completion.</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line"><tt class="py-docstring">    @bug: Works?</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt>  <tt class="py-line"><tt class="py-docstring">    @todo: Implement doctesting</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line"> </tt>
<a name="CustomCompleter.global_matches"></a><div id="CustomCompleter.global_matches-def"><a name="L271"></a><tt class="py-lineno">271</tt> <a class="py-toggle" href="#" id="CustomCompleter.global_matches-toggle" onclick="return toggle('CustomCompleter.global_matches');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.CustomCompleter-class.html#global_matches">global_matches</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="CustomCompleter.global_matches-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="CustomCompleter.global_matches-expanded"><a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line"><tt class="py-docstring">        Overrides C{rlcompleter.Completer.global_matches} to ignore builtins and</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line"><tt class="py-docstring">        python language keywords for completion. Computes matches when text is</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line"><tt class="py-docstring">        a simple name.</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line"><tt class="py-docstring">        @param text: A simple name to be matched in C{self.namespace}</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line"><tt class="py-docstring">        @type text: C{str}</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line"><tt class="py-docstring">        @return: A list of all keywords, names defined in C{self.namespace} that match</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{list}</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line">        <tt class="py-name">matches</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line">        <tt class="py-name">n</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">text</tt><tt class="py-op">)</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">word</tt><tt class="py-op">,</tt> <tt class="py-name">val</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">word</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">n</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">text</tt> <tt class="py-keyword">and</tt> <tt class="py-name">word</tt> <tt class="py-op">!=</tt> <tt class="py-string">"__builtins__"</tt><tt class="py-op">:</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line">                <tt class="py-name">matches</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callable_postfix</tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">word</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">matches</tt> </tt>
</div></div><a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line">     </tt>
<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line"><tt class="py-comment">## Interactive Shell &amp; Built-In Commands</tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell"></a><div id="InteractiveShell-def"><a name="L294"></a><tt class="py-lineno">294</tt> <a class="py-toggle" href="#" id="InteractiveShell-toggle" onclick="return toggle('InteractiveShell');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="console.interactive.InteractiveShell-class.html">InteractiveShell</a><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InteractiveShell-expanded"><a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line"><tt class="py-docstring">    Gives the user a custom prompt and the ability to type built in commands to</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line"><tt class="py-docstring">    the interactive console. This class represents the core of the console</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line"><tt class="py-docstring">    program, and must contain one or more L{InteractiveCommand}s to provide</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line"><tt class="py-docstring">    functionality to the user.</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line"><tt class="py-docstring">    @ivar banner: The message to be displayed at the top of the shell, right after the program starts</tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line"><tt class="py-docstring">    @type banner: C{str}</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line"><tt class="py-docstring">    @ivar prompt: A string that is displayed to the user while awaiting commands</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line"><tt class="py-docstring">    @type prompt: C{str}</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line"><tt class="py-docstring">    @ivar commands: A dictionary of available commands, where the key is the command name and the value is the command object</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line"><tt class="py-docstring">    @type commands: C{dict}</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt>  <tt class="py-line"><tt class="py-docstring">    @cvar _HelpCommand: Prints a list of available commands and their descriptions, or the help text of a specific command</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line"><tt class="py-docstring">    @type _HelpCommand: L{InteractiveCommand}</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt>  <tt class="py-line"><tt class="py-docstring">    @cvar _ExitCommand: Exits the interactive shell</tt> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line"><tt class="py-docstring">    @type _ExitCommand: L{InteractiveCommand}</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line"> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt>  <tt class="py-line">    <tt class="py-comment">###################################################################### </tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt>  <tt class="py-line">    <tt class="py-comment">## Built-In Commands</tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt>  <tt class="py-line">    <tt class="py-comment">###################################################################### </tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell._HelpCommand"></a><div id="InteractiveShell._HelpCommand-def"><a name="L318"></a><tt class="py-lineno">318</tt> <a class="py-toggle" href="#" id="InteractiveShell._HelpCommand-toggle" onclick="return toggle('InteractiveShell._HelpCommand');">-</a><tt class="py-line">    <tt class="py-keyword">class</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._HelpCommand-class.html">_HelpCommand</a><tt class="py-op">(</tt><tt class="py-base-class">InteractiveCommand</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._HelpCommand-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveShell._HelpCommand-expanded"><a name="L319"></a><tt class="py-lineno">319</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt>  <tt class="py-line"><tt class="py-docstring">        Prints a list of available commands and their descriptions, or the help</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line"><tt class="py-docstring">        text of a specific command. Requires a list of the available commands in</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line"><tt class="py-docstring">        order to display text for them. </tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line"><tt class="py-docstring">        @ivar commands: A dictionary of available commands, bound to L{InteractiveShell.commands}</tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line"><tt class="py-docstring">        @type commands: C{dict}</tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="InteractiveShell._HelpCommand.__init__"></a><div id="InteractiveShell._HelpCommand.__init__-def"><a name="L327"></a><tt class="py-lineno">327</tt> <a class="py-toggle" href="#" id="InteractiveShell._HelpCommand.__init__-toggle" onclick="return toggle('InteractiveShell._HelpCommand.__init__');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._HelpCommand-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">commands</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._HelpCommand.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._HelpCommand.__init__-expanded"><a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line">            <tt class="py-docstring">"""</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line"><tt class="py-docstring">            Constructor function for L{_HelpCommand}.</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line"><tt class="py-docstring">            @param commands: A dictionary of available commands, usually L{InteractiveShell.commands}</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt>  <tt class="py-line"><tt class="py-docstring">            @type commands: C{dict}</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line"><tt class="py-docstring">            """</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt> <tt class="py-op">=</tt> <tt class="py-name">commands</tt> </tt>
</div><a name="L335"></a><tt class="py-lineno">335</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell._HelpCommand.get_name"></a><div id="InteractiveShell._HelpCommand.get_name-def"><a name="L336"></a><tt class="py-lineno">336</tt> <a class="py-toggle" href="#" id="InteractiveShell._HelpCommand.get_name-toggle" onclick="return toggle('InteractiveShell._HelpCommand.get_name');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._HelpCommand-class.html#get_name">get_name</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._HelpCommand.get_name-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._HelpCommand.get_name-expanded"><a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">'help'</tt> </tt>
</div><a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line">     </tt>
<a name="InteractiveShell._HelpCommand.get_options"></a><div id="InteractiveShell._HelpCommand.get_options-def"><a name="L339"></a><tt class="py-lineno">339</tt> <a class="py-toggle" href="#" id="InteractiveShell._HelpCommand.get_options-toggle" onclick="return toggle('InteractiveShell._HelpCommand.get_options');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._HelpCommand-class.html#get_options">get_options</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._HelpCommand.get_options-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._HelpCommand.get_options-expanded"><a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-op">{</tt> <tt class="py-op">}</tt> </tt>
</div><a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell._HelpCommand.handle_command"></a><div id="InteractiveShell._HelpCommand.handle_command-def"><a name="L342"></a><tt class="py-lineno">342</tt> <a class="py-toggle" href="#" id="InteractiveShell._HelpCommand.handle_command-toggle" onclick="return toggle('InteractiveShell._HelpCommand.handle_command');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._HelpCommand-class.html#handle_command">handle_command</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">opts</tt><tt class="py-op">,</tt> <tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._HelpCommand.handle_command-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._HelpCommand.handle_command-expanded"><a name="L343"></a><tt class="py-lineno">343</tt>  <tt class="py-line">            <tt class="py-docstring">"""</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt>  <tt class="py-line"><tt class="py-docstring">            Prints a list of available commands and their descriptions if no</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt>  <tt class="py-line"><tt class="py-docstring">            argument is provided. Otherwise, prints the help text of the named</tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt>  <tt class="py-line"><tt class="py-docstring">            argument that represents a command. Does not throw an error if the</tt> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt>  <tt class="py-line"><tt class="py-docstring">            named argument doesn't exist in commands, simply prints a warning.</tt> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt>  <tt class="py-line"><tt class="py-docstring">            @param opts: Will be an empty dictionary</tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt>  <tt class="py-line"><tt class="py-docstring">            @type opts: C{dict}</tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt>  <tt class="py-line"><tt class="py-docstring">            @param args: The raw string passed to the command, either a command or nothing</tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt>  <tt class="py-line"><tt class="py-docstring">            @type args: C{str}</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt>  <tt class="py-line"><tt class="py-docstring">            @return: Returns nothing, sends messages to stdout</tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt>  <tt class="py-line"><tt class="py-docstring">            @rtype: None</tt> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt>  <tt class="py-line"><tt class="py-docstring">            """</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Method console.interactive.InteractiveShell._HelpCommand.do_command_summary()=console.interactive.InteractiveShell._HelpCommand-class.html#do_command_summary"><a title="console.interactive.InteractiveShell._HelpCommand.do_command_summary" class="py-name" href="#" onclick="return doclink('link-0', 'do_command_summary', 'link-0');">do_command_summary</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt>  <tt class="py-line"> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">:</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-string">'No help available for unknown command "%s"'</tt> <tt class="py-op">%</tt> <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt>  <tt class="py-line">             </tt>
<a name="L365"></a><tt class="py-lineno">365</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">[</tt><tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Method console.example.CustomShell._CustomCommand.get_help_message()=console.example.CustomShell._CustomCommand-class.html#get_help_message,Method console.interactive.InteractiveCommand.get_help_message()=console.interactive.InteractiveCommand-class.html#get_help_message,Method console.interactive.InteractiveShell._ExitCommand.get_help_message()=console.interactive.InteractiveShell._ExitCommand-class.html#get_help_message,Method console.interactive.InteractiveShell._HelpCommand.get_help_message()=console.interactive.InteractiveShell._HelpCommand-class.html#get_help_message"><a title="console.example.CustomShell._CustomCommand.get_help_message
console.interactive.InteractiveCommand.get_help_message
console.interactive.InteractiveShell._ExitCommand.get_help_message
console.interactive.InteractiveShell._HelpCommand.get_help_message" class="py-name" href="#" onclick="return doclink('link-1', 'get_help_message', 'link-1');">get_help_message</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
</div><a name="L366"></a><tt class="py-lineno">366</tt>  <tt class="py-line">             </tt>
<a name="L367"></a><tt class="py-lineno">367</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell._HelpCommand.do_command_summary"></a><div id="InteractiveShell._HelpCommand.do_command_summary-def"><a name="L368"></a><tt class="py-lineno">368</tt> <a class="py-toggle" href="#" id="InteractiveShell._HelpCommand.do_command_summary-toggle" onclick="return toggle('InteractiveShell._HelpCommand.do_command_summary');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._HelpCommand-class.html#do_command_summary">do_command_summary</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._HelpCommand.do_command_summary-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._HelpCommand.do_command_summary-expanded"><a name="L369"></a><tt class="py-lineno">369</tt>  <tt class="py-line">            <tt class="py-docstring">"""</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt>  <tt class="py-line"><tt class="py-docstring">            If no command is given to display help text for specifically, then</tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt>  <tt class="py-line"><tt class="py-docstring">            this helper method is called to print out a list of the available</tt> </tt>
<a name="L372"></a><tt class="py-lineno">372</tt>  <tt class="py-line"><tt class="py-docstring">            commands and their descriptions. Iterates over the list of commands,</tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt>  <tt class="py-line"><tt class="py-docstring">            and gets their summary from L{InteractiveCommand.get_short_description}</tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt>  <tt class="py-line"><tt class="py-docstring">            @return: Returns nothing, sends messages to stdout</tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt>  <tt class="py-line"><tt class="py-docstring">            @rtype: C{None}</tt> </tt>
<a name="L377"></a><tt class="py-lineno">377</tt>  <tt class="py-line"><tt class="py-docstring">            """</tt> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-string">'The following commands are available:\n'</tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt>  <tt class="py-line">            <tt class="py-name">cmdwidth</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-name">cmdwidth</tt><tt class="py-op">:</tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt>  <tt class="py-line">                    <tt class="py-name">cmdwidth</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
<a name="L383"></a><tt class="py-lineno">383</tt>  <tt class="py-line"> </tt>
<a name="L384"></a><tt class="py-lineno">384</tt>  <tt class="py-line">            <tt class="py-name">cmdwidth</tt> <tt class="py-op">+=</tt> <tt class="py-number">2</tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">sorted</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L386"></a><tt class="py-lineno">386</tt>  <tt class="py-line">                <tt class="py-name">command</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt>  <tt class="py-line"> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-op">==</tt> <tt class="py-string">'help'</tt><tt class="py-op">:</tt> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt>  <tt class="py-line">                    <tt class="py-keyword">continue</tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt>  <tt class="py-line">                 </tt>
<a name="L391"></a><tt class="py-lineno">391</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-string">'  %s   %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">.</tt><tt class="py-name">ljust</tt><tt class="py-op">(</tt><tt class="py-name">cmdwidth</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt>  <tt class="py-line">                                     <tt class="py-name">command</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Method console.example.CustomShell._CustomCommand.get_short_description()=console.example.CustomShell._CustomCommand-class.html#get_short_description,Method console.interactive.InteractiveCommand.get_short_description()=console.interactive.InteractiveCommand-class.html#get_short_description,Method console.interactive.InteractiveShell._ExitCommand.get_short_description()=console.interactive.InteractiveShell._ExitCommand-class.html#get_short_description,Method console.interactive.InteractiveShell._HelpCommand.get_short_description()=console.interactive.InteractiveShell._HelpCommand-class.html#get_short_description"><a title="console.example.CustomShell._CustomCommand.get_short_description
console.interactive.InteractiveCommand.get_short_description
console.interactive.InteractiveShell._ExitCommand.get_short_description
console.interactive.InteractiveShell._HelpCommand.get_short_description" class="py-name" href="#" onclick="return doclink('link-2', 'get_short_description', 'link-2');">get_short_description</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L393"></a><tt class="py-lineno">393</tt>  <tt class="py-line">                 </tt>
<a name="L394"></a><tt class="py-lineno">394</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell._HelpCommand.get_short_description"></a><div id="InteractiveShell._HelpCommand.get_short_description-def"><a name="L395"></a><tt class="py-lineno">395</tt> <a class="py-toggle" href="#" id="InteractiveShell._HelpCommand.get_short_description-toggle" onclick="return toggle('InteractiveShell._HelpCommand.get_short_description');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._HelpCommand-class.html#get_short_description">get_short_description</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._HelpCommand.get_short_description-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._HelpCommand.get_short_description-expanded"><a name="L396"></a><tt class="py-lineno">396</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
</div><a name="L397"></a><tt class="py-lineno">397</tt>  <tt class="py-line">     </tt>
<a name="InteractiveShell._HelpCommand.get_help_message"></a><div id="InteractiveShell._HelpCommand.get_help_message-def"><a name="L398"></a><tt class="py-lineno">398</tt> <a class="py-toggle" href="#" id="InteractiveShell._HelpCommand.get_help_message-toggle" onclick="return toggle('InteractiveShell._HelpCommand.get_help_message');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._HelpCommand-class.html#get_help_message">get_help_message</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._HelpCommand.get_help_message-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._HelpCommand.get_help_message-expanded"><a name="L399"></a><tt class="py-lineno">399</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
</div></div><a name="L400"></a><tt class="py-lineno">400</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell._ExitCommand"></a><div id="InteractiveShell._ExitCommand-def"><a name="L401"></a><tt class="py-lineno">401</tt> <a class="py-toggle" href="#" id="InteractiveShell._ExitCommand-toggle" onclick="return toggle('InteractiveShell._ExitCommand');">-</a><tt class="py-line">    <tt class="py-keyword">class</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._ExitCommand-class.html">_ExitCommand</a><tt class="py-op">(</tt><tt class="py-base-class">InteractiveCommand</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._ExitCommand-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveShell._ExitCommand-expanded"><a name="L402"></a><tt class="py-lineno">402</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L403"></a><tt class="py-lineno">403</tt>  <tt class="py-line"><tt class="py-docstring">        Exits the interactive shell. </tt> </tt>
<a name="L404"></a><tt class="py-lineno">404</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="InteractiveShell._ExitCommand.get_name"></a><div id="InteractiveShell._ExitCommand.get_name-def"><a name="L405"></a><tt class="py-lineno">405</tt> <a class="py-toggle" href="#" id="InteractiveShell._ExitCommand.get_name-toggle" onclick="return toggle('InteractiveShell._ExitCommand.get_name');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._ExitCommand-class.html#get_name">get_name</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._ExitCommand.get_name-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._ExitCommand.get_name-expanded"><a name="L406"></a><tt class="py-lineno">406</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">'exit'</tt> </tt>
</div><a name="L407"></a><tt class="py-lineno">407</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell._ExitCommand.get_options"></a><div id="InteractiveShell._ExitCommand.get_options-def"><a name="L408"></a><tt class="py-lineno">408</tt> <a class="py-toggle" href="#" id="InteractiveShell._ExitCommand.get_options-toggle" onclick="return toggle('InteractiveShell._ExitCommand.get_options');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._ExitCommand-class.html#get_options">get_options</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._ExitCommand.get_options-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._ExitCommand.get_options-expanded"><a name="L409"></a><tt class="py-lineno">409</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-op">{</tt> <tt class="py-op">}</tt> </tt>
</div><a name="L410"></a><tt class="py-lineno">410</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell._ExitCommand.handle_command"></a><div id="InteractiveShell._ExitCommand.handle_command-def"><a name="L411"></a><tt class="py-lineno">411</tt> <a class="py-toggle" href="#" id="InteractiveShell._ExitCommand.handle_command-toggle" onclick="return toggle('InteractiveShell._ExitCommand.handle_command');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._ExitCommand-class.html#handle_command">handle_command</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">opts</tt><tt class="py-op">,</tt> <tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._ExitCommand.handle_command-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._ExitCommand.handle_command-expanded"><a name="L412"></a><tt class="py-lineno">412</tt>  <tt class="py-line">            <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">exit</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
</div><a name="L413"></a><tt class="py-lineno">413</tt>  <tt class="py-line"> </tt>
<a name="L414"></a><tt class="py-lineno">414</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell._ExitCommand.get_short_description"></a><div id="InteractiveShell._ExitCommand.get_short_description-def"><a name="L415"></a><tt class="py-lineno">415</tt> <a class="py-toggle" href="#" id="InteractiveShell._ExitCommand.get_short_description-toggle" onclick="return toggle('InteractiveShell._ExitCommand.get_short_description');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._ExitCommand-class.html#get_short_description">get_short_description</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._ExitCommand.get_short_description-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._ExitCommand.get_short_description-expanded"><a name="L416"></a><tt class="py-lineno">416</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">'Exit the program.'</tt> </tt>
</div><a name="L417"></a><tt class="py-lineno">417</tt>  <tt class="py-line">     </tt>
<a name="InteractiveShell._ExitCommand.get_help_message"></a><div id="InteractiveShell._ExitCommand.get_help_message-def"><a name="L418"></a><tt class="py-lineno">418</tt> <a class="py-toggle" href="#" id="InteractiveShell._ExitCommand.get_help_message-toggle" onclick="return toggle('InteractiveShell._ExitCommand.get_help_message');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell._ExitCommand-class.html#get_help_message">get_help_message</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell._ExitCommand.get_help_message-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="InteractiveShell._ExitCommand.get_help_message-expanded"><a name="L419"></a><tt class="py-lineno">419</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">'Type exit and the program will exit.  There are no options to this command'</tt> </tt>
</div></div><a name="L420"></a><tt class="py-lineno">420</tt>  <tt class="py-line"> </tt>
<a name="L421"></a><tt class="py-lineno">421</tt>  <tt class="py-line">    <tt class="py-comment">###################################################################### </tt> </tt>
<a name="L422"></a><tt class="py-lineno">422</tt>  <tt class="py-line">    <tt class="py-comment">## InteractiveShell Methods</tt> </tt>
<a name="L423"></a><tt class="py-lineno">423</tt>  <tt class="py-line">    <tt class="py-comment">######################################################################</tt> </tt>
<a name="L424"></a><tt class="py-lineno">424</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell.__init__"></a><div id="InteractiveShell.__init__-def"><a name="L425"></a><tt class="py-lineno">425</tt> <a class="py-toggle" href="#" id="InteractiveShell.__init__-toggle" onclick="return toggle('InteractiveShell.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell-class.html#__init__">__init__</a><tt class="py-op">(</tt> <tt class="py-param">self</tt><tt class="py-op">,</tt>  </tt>
<a name="L426"></a><tt class="py-lineno">426</tt>  <tt class="py-line">                  <tt class="py-param">banner</tt><tt class="py-op">=</tt><tt class="py-string">"Welcome to Interactive Shell"</tt><tt class="py-op">,</tt> </tt>
<a name="L427"></a><tt class="py-lineno">427</tt>  <tt class="py-line">                  <tt class="py-param">prompt</tt><tt class="py-op">=</tt><tt class="py-string">" &gt;&gt;&gt; "</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveShell.__init__-expanded"><a name="L428"></a><tt class="py-lineno">428</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">banner</tt> <tt class="py-op">=</tt> <tt class="py-name">banner</tt> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">prompt</tt> <tt class="py-op">=</tt> <tt class="py-name">prompt</tt> </tt>
<a name="L430"></a><tt class="py-lineno">430</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-op">}</tt> </tt>
<a name="L431"></a><tt class="py-lineno">431</tt>  <tt class="py-line"> </tt>
<a name="L432"></a><tt class="py-lineno">432</tt>  <tt class="py-line">        <tt class="py-name">helpcmd</tt> <tt class="py-op">=</tt> <tt id="link-3" class="py-name" targets="Class console.interactive.InteractiveShell=console.interactive.InteractiveShell-class.html"><a title="console.interactive.InteractiveShell" class="py-name" href="#" onclick="return doclink('link-3', 'InteractiveShell', 'link-3');">InteractiveShell</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Class console.interactive.InteractiveShell._HelpCommand=console.interactive.InteractiveShell._HelpCommand-class.html"><a title="console.interactive.InteractiveShell._HelpCommand" class="py-name" href="#" onclick="return doclink('link-4', '_HelpCommand', 'link-4');">_HelpCommand</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">)</tt> </tt>
<a name="L433"></a><tt class="py-lineno">433</tt>  <tt class="py-line">        <tt class="py-name">exitcmd</tt> <tt class="py-op">=</tt> <tt id="link-5" class="py-name"><a title="console.interactive.InteractiveShell" class="py-name" href="#" onclick="return doclink('link-5', 'InteractiveShell', 'link-3');">InteractiveShell</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Class console.interactive.InteractiveShell._ExitCommand=console.interactive.InteractiveShell._ExitCommand-class.html"><a title="console.interactive.InteractiveShell._ExitCommand" class="py-name" href="#" onclick="return doclink('link-6', '_ExitCommand', 'link-6');">_ExitCommand</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
<a name="L434"></a><tt class="py-lineno">434</tt>  <tt class="py-line"> </tt>
<a name="L435"></a><tt class="py-lineno">435</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method console.interactive.InteractiveShell.add_command()=console.interactive.InteractiveShell-class.html#add_command"><a title="console.interactive.InteractiveShell.add_command" class="py-name" href="#" onclick="return doclink('link-7', 'add_command', 'link-7');">add_command</a></tt><tt class="py-op">(</tt><tt class="py-name">helpcmd</tt><tt class="py-op">)</tt> </tt>
<a name="L436"></a><tt class="py-lineno">436</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="console.interactive.InteractiveShell.add_command" class="py-name" href="#" onclick="return doclink('link-8', 'add_command', 'link-7');">add_command</a></tt><tt class="py-op">(</tt><tt class="py-name">exitcmd</tt><tt class="py-op">)</tt> </tt>
</div><a name="L437"></a><tt class="py-lineno">437</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell.add_command"></a><div id="InteractiveShell.add_command-def"><a name="L438"></a><tt class="py-lineno">438</tt> <a class="py-toggle" href="#" id="InteractiveShell.add_command-toggle" onclick="return toggle('InteractiveShell.add_command');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell-class.html#add_command">add_command</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">command</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell.add_command-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveShell.add_command-expanded"><a name="L439"></a><tt class="py-lineno">439</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L440"></a><tt class="py-lineno">440</tt>  <tt class="py-line"><tt class="py-docstring">        Adds a command to the interactive shell. This should be called before</tt> </tt>
<a name="L441"></a><tt class="py-lineno">441</tt>  <tt class="py-line"><tt class="py-docstring">        L{InteractiveShell.run} in order to give the user some useful commands!</tt> </tt>
<a name="L442"></a><tt class="py-lineno">442</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L443"></a><tt class="py-lineno">443</tt>  <tt class="py-line"><tt class="py-docstring">        @param command: A command to be added to the interactive shell.</tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt>  <tt class="py-line"><tt class="py-docstring">        @type command: L{InteractiveCommand}</tt> </tt>
<a name="L445"></a><tt class="py-lineno">445</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L446"></a><tt class="py-lineno">446</tt>  <tt class="py-line"><tt class="py-docstring">        @return: Returns nothing, modifies the L{InteractiveShell} in place</tt> </tt>
<a name="L447"></a><tt class="py-lineno">447</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L448"></a><tt class="py-lineno">448</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L449"></a><tt class="py-lineno">449</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">command</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method console.example.CustomShell._CustomCommand.get_name()=console.example.CustomShell._CustomCommand-class.html#get_name,Method console.interactive.InteractiveCommand.get_name()=console.interactive.InteractiveCommand-class.html#get_name,Method console.interactive.InteractiveShell._ExitCommand.get_name()=console.interactive.InteractiveShell._ExitCommand-class.html#get_name,Method console.interactive.InteractiveShell._HelpCommand.get_name()=console.interactive.InteractiveShell._HelpCommand-class.html#get_name"><a title="console.example.CustomShell._CustomCommand.get_name
console.interactive.InteractiveCommand.get_name
console.interactive.InteractiveShell._ExitCommand.get_name
console.interactive.InteractiveShell._HelpCommand.get_name" class="py-name" href="#" onclick="return doclink('link-9', 'get_name', 'link-9');">get_name</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">:</tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt>  <tt class="py-line">            <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-string">'command %s already registered'</tt> <tt class="py-op">%</tt> <tt class="py-name">command</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="console.example.CustomShell._CustomCommand.get_name
console.interactive.InteractiveCommand.get_name
console.interactive.InteractiveShell._ExitCommand.get_name
console.interactive.InteractiveShell._HelpCommand.get_name" class="py-name" href="#" onclick="return doclink('link-10', 'get_name', 'link-9');">get_name</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt>  <tt class="py-line">         </tt>
<a name="L452"></a><tt class="py-lineno">452</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">[</tt><tt class="py-name">command</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="console.example.CustomShell._CustomCommand.get_name
console.interactive.InteractiveCommand.get_name
console.interactive.InteractiveShell._ExitCommand.get_name
console.interactive.InteractiveShell._HelpCommand.get_name" class="py-name" href="#" onclick="return doclink('link-11', 'get_name', 'link-9');">get_name</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">command</tt> </tt>
</div><a name="L453"></a><tt class="py-lineno">453</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell.handle_input"></a><div id="InteractiveShell.handle_input-def"><a name="L454"></a><tt class="py-lineno">454</tt> <a class="py-toggle" href="#" id="InteractiveShell.handle_input-toggle" onclick="return toggle('InteractiveShell.handle_input');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell-class.html#handle_input">handle_input</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">input</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell.handle_input-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveShell.handle_input-expanded"><a name="L455"></a><tt class="py-lineno">455</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L456"></a><tt class="py-lineno">456</tt>  <tt class="py-line"><tt class="py-docstring">        Worker task of the L{InteractiveShell} - takes the user input and</tt> </tt>
<a name="L457"></a><tt class="py-lineno">457</tt>  <tt class="py-line"><tt class="py-docstring">        parses it for commands, options, and arguments, calls the command with</tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt>  <tt class="py-line"><tt class="py-docstring">        its correct arguments.</tt> </tt>
<a name="L459"></a><tt class="py-lineno">459</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L460"></a><tt class="py-lineno">460</tt>  <tt class="py-line"><tt class="py-docstring">        @note: This method is called by L{InteractiveShell.run} method</tt> </tt>
<a name="L461"></a><tt class="py-lineno">461</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L462"></a><tt class="py-lineno">462</tt>  <tt class="py-line"><tt class="py-docstring">        @param input: The raw string input from the prompt line.</tt> </tt>
<a name="L463"></a><tt class="py-lineno">463</tt>  <tt class="py-line"><tt class="py-docstring">        @type input: C{str}</tt> </tt>
<a name="L464"></a><tt class="py-lineno">464</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L465"></a><tt class="py-lineno">465</tt>  <tt class="py-line"><tt class="py-docstring">        @return: Returns nothing, operational method</tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L467"></a><tt class="py-lineno">467</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L468"></a><tt class="py-lineno">468</tt>  <tt class="py-line">        <tt class="py-name">input</tt> <tt class="py-op">=</tt> <tt class="py-name">input</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
<a name="L469"></a><tt class="py-lineno">469</tt>  <tt class="py-line"> </tt>
<a name="L470"></a><tt class="py-lineno">470</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">input</tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> </tt>
<a name="L471"></a><tt class="py-lineno">471</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> </tt>
<a name="L472"></a><tt class="py-lineno">472</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> </tt>
<a name="L473"></a><tt class="py-lineno">473</tt>  <tt class="py-line"> </tt>
<a name="L474"></a><tt class="py-lineno">474</tt>  <tt class="py-line">        <tt class="py-comment"># Split the input to allow for quotes option values</tt> </tt>
<a name="L475"></a><tt class="py-lineno">475</tt>  <tt class="py-line">        <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">findall</tt><tt class="py-op">(</tt><tt class="py-string">'\-\-\S+\=\"[^\"]*\"|\S+'</tt><tt class="py-op">,</tt><tt class="py-name">input</tt><tt class="py-op">)</tt> </tt>
<a name="L476"></a><tt class="py-lineno">476</tt>  <tt class="py-line">         </tt>
<a name="L477"></a><tt class="py-lineno">477</tt>  <tt class="py-line">        <tt class="py-name">command</tt> <tt class="py-op">=</tt> <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L478"></a><tt class="py-lineno">478</tt>  <tt class="py-line">        <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L479"></a><tt class="py-lineno">479</tt>  <tt class="py-line"> </tt>
<a name="L480"></a><tt class="py-lineno">480</tt>  <tt class="py-line">        <tt class="py-comment"># strip off quotes from args if present</tt> </tt>
<a name="L481"></a><tt class="py-lineno">481</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">xrange</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L482"></a><tt class="py-lineno">482</tt>  <tt class="py-line">            <tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'='</tt><tt class="py-op">)</tt> </tt>
<a name="L483"></a><tt class="py-lineno">483</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">parts</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L484"></a><tt class="py-lineno">484</tt>  <tt class="py-line">                <tt class="py-keyword">continue</tt> </tt>
<a name="L485"></a><tt class="py-lineno">485</tt>  <tt class="py-line"> </tt>
<a name="L486"></a><tt class="py-lineno">486</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L487"></a><tt class="py-lineno">487</tt>  <tt class="py-line">                <tt class="py-keyword">continue</tt> </tt>
<a name="L488"></a><tt class="py-lineno">488</tt>  <tt class="py-line"> </tt>
<a name="L489"></a><tt class="py-lineno">489</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-op">(</tt> <tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-string">'"'</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L490"></a><tt class="py-lineno">490</tt>  <tt class="py-line">                 <tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-string">'"'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L491"></a><tt class="py-lineno">491</tt>  <tt class="py-line">                <tt class="py-keyword">continue</tt> </tt>
<a name="L492"></a><tt class="py-lineno">492</tt>  <tt class="py-line"> </tt>
<a name="L493"></a><tt class="py-lineno">493</tt>  <tt class="py-line">            <tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">parts</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L494"></a><tt class="py-lineno">494</tt>  <tt class="py-line">            <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-string">'='</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">parts</tt><tt class="py-op">)</tt> </tt>
<a name="L495"></a><tt class="py-lineno">495</tt>  <tt class="py-line"> </tt>
<a name="L496"></a><tt class="py-lineno">496</tt>  <tt class="py-line">         </tt>
<a name="L497"></a><tt class="py-lineno">497</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">command</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">:</tt> </tt>
<a name="L498"></a><tt class="py-lineno">498</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-string">'Unknown command: "%s". Type "help" for a list of commands.'</tt> <tt class="py-op">%</tt> <tt class="py-name">command</tt> </tt>
<a name="L499"></a><tt class="py-lineno">499</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> </tt>
<a name="L500"></a><tt class="py-lineno">500</tt>  <tt class="py-line">                 </tt>
<a name="L501"></a><tt class="py-lineno">501</tt>  <tt class="py-line">        <tt class="py-name">command</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">[</tt><tt class="py-name">command</tt><tt class="py-op">]</tt> </tt>
<a name="L502"></a><tt class="py-lineno">502</tt>  <tt class="py-line"> </tt>
<a name="L503"></a><tt class="py-lineno">503</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">command</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Method console.example.CustomShell._CustomCommand.get_options()=console.example.CustomShell._CustomCommand-class.html#get_options,Method console.interactive.InteractiveCommand.get_options()=console.interactive.InteractiveCommand-class.html#get_options,Method console.interactive.InteractiveShell._ExitCommand.get_options()=console.interactive.InteractiveShell._ExitCommand-class.html#get_options,Method console.interactive.InteractiveShell._HelpCommand.get_options()=console.interactive.InteractiveShell._HelpCommand-class.html#get_options"><a title="console.example.CustomShell._CustomCommand.get_options
console.interactive.InteractiveCommand.get_options
console.interactive.InteractiveShell._ExitCommand.get_options
console.interactive.InteractiveShell._HelpCommand.get_options" class="py-name" href="#" onclick="return doclink('link-12', 'get_options', 'link-12');">get_options</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L504"></a><tt class="py-lineno">504</tt>  <tt class="py-line">            <tt class="py-name">opts</tt> <tt class="py-op">=</tt> <tt id="link-13" class="py-name" targets="Function console.interactive.get_option_dict()=console.interactive-module.html#get_option_dict"><a title="console.interactive.get_option_dict" class="py-name" href="#" onclick="return doclink('link-13', 'get_option_dict', 'link-13');">get_option_dict</a></tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-name">command</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name"><a title="console.example.CustomShell._CustomCommand.get_options
console.interactive.InteractiveCommand.get_options
console.interactive.InteractiveShell._ExitCommand.get_options
console.interactive.InteractiveShell._HelpCommand.get_options" class="py-name" href="#" onclick="return doclink('link-14', 'get_options', 'link-12');">get_options</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L505"></a><tt class="py-lineno">505</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">opts</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L506"></a><tt class="py-lineno">506</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-op">(</tt><tt class="py-string">'Invalid command or option supplied '</tt> </tt>
<a name="L507"></a><tt class="py-lineno">507</tt>  <tt class="py-line">                <tt class="py-string">'(use "help &lt;command&gt;" for usage).'</tt><tt class="py-op">)</tt> </tt>
<a name="L508"></a><tt class="py-lineno">508</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> </tt>
<a name="L509"></a><tt class="py-lineno">509</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L510"></a><tt class="py-lineno">510</tt>  <tt class="py-line">            <tt class="py-name">opts</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-op">}</tt> </tt>
<a name="L511"></a><tt class="py-lineno">511</tt>  <tt class="py-line">             </tt>
<a name="L512"></a><tt class="py-lineno">512</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">option</tt><tt class="py-op">,</tt> <tt class="py-name">default</tt> <tt class="py-keyword">in</tt> <tt class="py-name">command</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="console.example.CustomShell._CustomCommand.get_options
console.interactive.InteractiveCommand.get_options
console.interactive.InteractiveShell._ExitCommand.get_options
console.interactive.InteractiveShell._HelpCommand.get_options" class="py-name" href="#" onclick="return doclink('link-15', 'get_options', 'link-12');">get_options</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L513"></a><tt class="py-lineno">513</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">option</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'='</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L514"></a><tt class="py-lineno">514</tt>  <tt class="py-line">                <tt class="py-name">option_name</tt> <tt class="py-op">=</tt> <tt class="py-name">option</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L515"></a><tt class="py-lineno">515</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L516"></a><tt class="py-lineno">516</tt>  <tt class="py-line">                <tt class="py-name">option_name</tt> <tt class="py-op">=</tt> <tt class="py-name">option</tt> </tt>
<a name="L517"></a><tt class="py-lineno">517</tt>  <tt class="py-line"> </tt>
<a name="L518"></a><tt class="py-lineno">518</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-op">(</tt> <tt class="py-name">default</tt> <tt class="py-op">!=</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L519"></a><tt class="py-lineno">519</tt>  <tt class="py-line">                 <tt class="py-name">option</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'='</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L520"></a><tt class="py-lineno">520</tt>  <tt class="py-line">                 <tt class="py-name">option_name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">opts</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L521"></a><tt class="py-lineno">521</tt>  <tt class="py-line">                <tt class="py-name">opts</tt><tt class="py-op">[</tt><tt class="py-name">option_name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">default</tt> </tt>
<a name="L522"></a><tt class="py-lineno">522</tt>  <tt class="py-line"> </tt>
<a name="L523"></a><tt class="py-lineno">523</tt>  <tt class="py-line">            <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt> <tt class="py-name">option_name</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">opts</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L524"></a><tt class="py-lineno">524</tt>  <tt class="py-line">                   <tt class="py-name">default</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L525"></a><tt class="py-lineno">525</tt>  <tt class="py-line">                   <tt class="py-name">option</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'='</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L526"></a><tt class="py-lineno">526</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-string">'Error: must supply a value for option "%s"'</tt> <tt class="py-op">%</tt> <tt class="py-name">option_name</tt> </tt>
<a name="L527"></a><tt class="py-lineno">527</tt>  <tt class="py-line">                <tt class="py-keyword">return</tt> </tt>
<a name="L528"></a><tt class="py-lineno">528</tt>  <tt class="py-line">             </tt>
<a name="L529"></a><tt class="py-lineno">529</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L530"></a><tt class="py-lineno">530</tt>  <tt class="py-line">            <tt class="py-name">command</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method console.example.CustomShell._CustomCommand.handle_command()=console.example.CustomShell._CustomCommand-class.html#handle_command,Method console.interactive.InteractiveCommand.handle_command()=console.interactive.InteractiveCommand-class.html#handle_command,Method console.interactive.InteractiveShell._ExitCommand.handle_command()=console.interactive.InteractiveShell._ExitCommand-class.html#handle_command,Method console.interactive.InteractiveShell._HelpCommand.handle_command()=console.interactive.InteractiveShell._HelpCommand-class.html#handle_command"><a title="console.example.CustomShell._CustomCommand.handle_command
console.interactive.InteractiveCommand.handle_command
console.interactive.InteractiveShell._ExitCommand.handle_command
console.interactive.InteractiveShell._HelpCommand.handle_command" class="py-name" href="#" onclick="return doclink('link-16', 'handle_command', 'link-16');">handle_command</a></tt><tt class="py-op">(</tt><tt class="py-name">opts</tt><tt class="py-op">,</tt> <tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L531"></a><tt class="py-lineno">531</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L532"></a><tt class="py-lineno">532</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-string">"Exception occurred while processing command."</tt> </tt>
<a name="L533"></a><tt class="py-lineno">533</tt>  <tt class="py-line">            <tt class="py-name">traceback</tt><tt class="py-op">.</tt><tt class="py-name">print_exc</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
</div><a name="L534"></a><tt class="py-lineno">534</tt>  <tt class="py-line"> </tt>
<a name="InteractiveShell.run"></a><div id="InteractiveShell.run-def"><a name="L535"></a><tt class="py-lineno">535</tt> <a class="py-toggle" href="#" id="InteractiveShell.run-toggle" onclick="return toggle('InteractiveShell.run');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.InteractiveShell-class.html#run">run</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveShell.run-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveShell.run-expanded"><a name="L536"></a><tt class="py-lineno">536</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L537"></a><tt class="py-lineno">537</tt>  <tt class="py-line"><tt class="py-docstring">        Starts up the L{InteractiveShell} with the correct command prompt,</tt> </tt>
<a name="L538"></a><tt class="py-lineno">538</tt>  <tt class="py-line"><tt class="py-docstring">        completer, and banner; then listens for commands from the user and</tt> </tt>
<a name="L539"></a><tt class="py-lineno">539</tt>  <tt class="py-line"><tt class="py-docstring">        executes them when it receives them.</tt> </tt>
<a name="L540"></a><tt class="py-lineno">540</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L541"></a><tt class="py-lineno">541</tt>  <tt class="py-line"><tt class="py-docstring">        @return: Returns nothing, operational method</tt> </tt>
<a name="L542"></a><tt class="py-lineno">542</tt>  <tt class="py-line"><tt class="py-docstring">        @rtype: C{None}</tt> </tt>
<a name="L543"></a><tt class="py-lineno">543</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L544"></a><tt class="py-lineno">544</tt>  <tt class="py-line">        <tt class="py-name">namespace</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-op">}</tt> </tt>
<a name="L545"></a><tt class="py-lineno">545</tt>  <tt class="py-line">         </tt>
<a name="L546"></a><tt class="py-lineno">546</tt>  <tt class="py-line">         </tt>
<a name="L547"></a><tt class="py-lineno">547</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt><tt class="py-name">command</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">commands</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L548"></a><tt class="py-lineno">548</tt>  <tt class="py-line">            <tt class="py-name">namespace</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L549"></a><tt class="py-lineno">549</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">option</tt> <tt class="py-keyword">in</tt> <tt class="py-name">command</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="console.example.CustomShell._CustomCommand.get_options
console.interactive.InteractiveCommand.get_options
console.interactive.InteractiveShell._ExitCommand.get_options
console.interactive.InteractiveShell._HelpCommand.get_options" class="py-name" href="#" onclick="return doclink('link-17', 'get_options', 'link-12');">get_options</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L550"></a><tt class="py-lineno">550</tt>  <tt class="py-line">                <tt class="py-name">namespace</tt><tt class="py-op">[</tt><tt class="py-name">option</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L551"></a><tt class="py-lineno">551</tt>  <tt class="py-line"> </tt>
<a name="L552"></a><tt class="py-lineno">552</tt>  <tt class="py-line">        <tt class="py-name">readline</tt><tt class="py-op">.</tt><tt class="py-name">set_completer</tt><tt class="py-op">(</tt> <tt id="link-18" class="py-name" targets="Class console.interactive.CustomCompleter=console.interactive.CustomCompleter-class.html"><a title="console.interactive.CustomCompleter" class="py-name" href="#" onclick="return doclink('link-18', 'CustomCompleter', 'link-18');">CustomCompleter</a></tt><tt class="py-op">(</tt><tt class="py-name">namespace</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">complete</tt> <tt class="py-op">)</tt> </tt>
<a name="L553"></a><tt class="py-lineno">553</tt>  <tt class="py-line"> </tt>
<a name="L554"></a><tt class="py-lineno">554</tt>  <tt class="py-line">        <tt class="py-name">readline</tt><tt class="py-op">.</tt><tt class="py-name">parse_and_bind</tt><tt class="py-op">(</tt><tt class="py-string">"tab: complete"</tt><tt class="py-op">)</tt> </tt>
<a name="L555"></a><tt class="py-lineno">555</tt>  <tt class="py-line">             </tt>
<a name="L556"></a><tt class="py-lineno">556</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">banner</tt> </tt>
<a name="L557"></a><tt class="py-lineno">557</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> </tt>
<a name="L558"></a><tt class="py-lineno">558</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">'Type "help" at any time for a list of commands.'</tt> </tt>
<a name="L559"></a><tt class="py-lineno">559</tt>  <tt class="py-line"> </tt>
<a name="L560"></a><tt class="py-lineno">560</tt>  <tt class="py-line">        <tt class="py-keyword">while</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L561"></a><tt class="py-lineno">561</tt>  <tt class="py-line">            <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L562"></a><tt class="py-lineno">562</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> </tt>
<a name="L563"></a><tt class="py-lineno">563</tt>  <tt class="py-line">                <tt class="py-name">input</tt> <tt class="py-op">=</tt> <tt class="py-name">raw_input</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">prompt</tt><tt class="py-op">)</tt> </tt>
<a name="L564"></a><tt class="py-lineno">564</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-op">(</tt><tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">,</tt> <tt class="py-name">EOFError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L565"></a><tt class="py-lineno">565</tt>  <tt class="py-line">                <tt class="py-keyword">break</tt> </tt>
<a name="L566"></a><tt class="py-lineno">566</tt>  <tt class="py-line"> </tt>
<a name="L567"></a><tt class="py-lineno">567</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name" targets="Method console.interactive.InteractiveShell.handle_input()=console.interactive.InteractiveShell-class.html#handle_input"><a title="console.interactive.InteractiveShell.handle_input" class="py-name" href="#" onclick="return doclink('link-19', 'handle_input', 'link-19');">handle_input</a></tt><tt class="py-op">(</tt><tt class="py-name">input</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L568"></a><tt class="py-lineno">568</tt>  <tt class="py-line"> </tt>
<a name="L569"></a><tt class="py-lineno">569</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L570"></a><tt class="py-lineno">570</tt>  <tt class="py-line"><tt class="py-comment">## Main Method (i.e. Testing)</tt> </tt>
<a name="L571"></a><tt class="py-lineno">571</tt>  <tt class="py-line"><tt class="py-comment">###################################################################### </tt> </tt>
<a name="L572"></a><tt class="py-lineno">572</tt>  <tt class="py-line"> </tt>
<a name="L573"></a><tt class="py-lineno">573</tt>  <tt class="py-line"><tt class="py-keyword">if</tt> <tt class="py-name">__name__</tt> <tt class="py-op">==</tt> <tt class="py-string">'__main__'</tt><tt class="py-op">:</tt> </tt>
<a name="L574"></a><tt class="py-lineno">574</tt>  <tt class="py-line"> </tt>
<a name="TestCommand"></a><div id="TestCommand-def"><a name="L575"></a><tt class="py-lineno">575</tt> <a class="py-toggle" href="#" id="TestCommand-toggle" onclick="return toggle('TestCommand');">-</a><tt class="py-line">    <tt class="py-keyword">class</tt> <a class="py-def-name" href="console.interactive.TestCommand-class.html">TestCommand</a><tt class="py-op">(</tt><tt class="py-base-class">InteractiveCommand</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TestCommand-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TestCommand-expanded"><a name="L576"></a><tt class="py-lineno">576</tt>  <tt class="py-line">         </tt>
<a name="TestCommand.get_name"></a><div id="TestCommand.get_name-def"><a name="L577"></a><tt class="py-lineno">577</tt> <a class="py-toggle" href="#" id="TestCommand.get_name-toggle" onclick="return toggle('TestCommand.get_name');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.TestCommand-class.html#get_name">get_name</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TestCommand.get_name-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="TestCommand.get_name-expanded"><a name="L578"></a><tt class="py-lineno">578</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">'test'</tt> </tt>
</div><a name="L579"></a><tt class="py-lineno">579</tt>  <tt class="py-line"> </tt>
<a name="TestCommand.get_options"></a><div id="TestCommand.get_options-def"><a name="L580"></a><tt class="py-lineno">580</tt> <a class="py-toggle" href="#" id="TestCommand.get_options-toggle" onclick="return toggle('TestCommand.get_options');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.TestCommand-class.html#get_options">get_options</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TestCommand.get_options-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="TestCommand.get_options-expanded"><a name="L581"></a><tt class="py-lineno">581</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-op">{</tt> <tt class="py-string">'opt1'</tt><tt class="py-op">:</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L582"></a><tt class="py-lineno">582</tt>  <tt class="py-line">                     <tt class="py-string">'opt2='</tt><tt class="py-op">:</tt> <tt class="py-string">'default'</tt><tt class="py-op">,</tt> </tt>
<a name="L583"></a><tt class="py-lineno">583</tt>  <tt class="py-line">                     <tt class="py-string">'required='</tt><tt class="py-op">:</tt> <tt class="py-name">None</tt><tt class="py-op">}</tt> </tt>
</div><a name="L584"></a><tt class="py-lineno">584</tt>  <tt class="py-line"> </tt>
<a name="TestCommand.handle_command"></a><div id="TestCommand.handle_command-def"><a name="L585"></a><tt class="py-lineno">585</tt> <a class="py-toggle" href="#" id="TestCommand.handle_command-toggle" onclick="return toggle('TestCommand.handle_command');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.TestCommand-class.html#handle_command">handle_command</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">opts</tt><tt class="py-op">,</tt> <tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TestCommand.handle_command-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="TestCommand.handle_command-expanded"><a name="L586"></a><tt class="py-lineno">586</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-string">'Test command running with options:'</tt> </tt>
<a name="L587"></a><tt class="py-lineno">587</tt>  <tt class="py-line"> </tt>
<a name="L588"></a><tt class="py-lineno">588</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">k</tt><tt class="py-op">,</tt><tt class="py-name">v</tt> <tt class="py-keyword">in</tt> <tt class="py-name">opts</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L589"></a><tt class="py-lineno">589</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt> <tt class="py-string">'%s =&gt; %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">k</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L590"></a><tt class="py-lineno">590</tt>  <tt class="py-line">             </tt>
<a name="L591"></a><tt class="py-lineno">591</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-string">'Args is: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">args</tt> </tt>
</div><a name="L592"></a><tt class="py-lineno">592</tt>  <tt class="py-line">             </tt>
<a name="TestCommand.get_short_description"></a><div id="TestCommand.get_short_description-def"><a name="L593"></a><tt class="py-lineno">593</tt> <a class="py-toggle" href="#" id="TestCommand.get_short_description-toggle" onclick="return toggle('TestCommand.get_short_description');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.TestCommand-class.html#get_short_description">get_short_description</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TestCommand.get_short_description-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="TestCommand.get_short_description-expanded"><a name="L594"></a><tt class="py-lineno">594</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">'I am a test command hear me roar'</tt> </tt>
</div><a name="L595"></a><tt class="py-lineno">595</tt>  <tt class="py-line"> </tt>
<a name="TestCommand.get_help_message"></a><div id="TestCommand.get_help_message-def"><a name="L596"></a><tt class="py-lineno">596</tt> <a class="py-toggle" href="#" id="TestCommand.get_help_message-toggle" onclick="return toggle('TestCommand.get_help_message');">-</a><tt class="py-line">        <tt class="py-keyword">def</tt> <a class="py-def-name" href="console.interactive.TestCommand-class.html#get_help_message">get_help_message</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TestCommand.get_help_message-collapsed" style="display:none;" pad="+++" indent="++++++++++++++++"></div><div id="TestCommand.get_help_message-expanded"><a name="L597"></a><tt class="py-lineno">597</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-string">'test --opt1=value [--opt2=value2]'</tt> </tt>
</div></div><a name="L598"></a><tt class="py-lineno">598</tt>  <tt class="py-line"> </tt>
<a name="L599"></a><tt class="py-lineno">599</tt>  <tt class="py-line">         </tt>
<a name="L600"></a><tt class="py-lineno">600</tt>  <tt class="py-line">    <tt class="py-name">tc</tt> <tt class="py-op">=</tt> <tt class="py-name">TestCommand</tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
<a name="L601"></a><tt class="py-lineno">601</tt>  <tt class="py-line"> </tt>
<a name="L602"></a><tt class="py-lineno">602</tt>  <tt class="py-line">    <tt class="py-name">shell</tt> <tt class="py-op">=</tt> <tt id="link-20" class="py-name"><a title="console.interactive.InteractiveShell" class="py-name" href="#" onclick="return doclink('link-20', 'InteractiveShell', 'link-3');">InteractiveShell</a></tt><tt class="py-op">(</tt> <tt class="py-name">banner</tt><tt class="py-op">=</tt><tt class="py-string">'Welcome to TestLand'</tt><tt class="py-op">,</tt> </tt>
<a name="L603"></a><tt class="py-lineno">603</tt>  <tt class="py-line">                           <tt class="py-name">prompt</tt><tt class="py-op">=</tt><tt class="py-string">' TEST &gt;&gt;&gt; '</tt><tt class="py-op">)</tt> </tt>
<a name="L604"></a><tt class="py-lineno">604</tt>  <tt class="py-line"> </tt>
<a name="L605"></a><tt class="py-lineno">605</tt>  <tt class="py-line">    <tt class="py-name">shell</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="console.interactive.InteractiveShell.add_command" class="py-name" href="#" onclick="return doclink('link-21', 'add_command', 'link-7');">add_command</a></tt><tt class="py-op">(</tt><tt class="py-name">tc</tt><tt class="py-op">)</tt> </tt>
<a name="L606"></a><tt class="py-lineno">606</tt>  <tt class="py-line"> </tt>
<a name="L607"></a><tt class="py-lineno">607</tt>  <tt class="py-line">    <tt class="py-name">shell</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name" targets="Method console.interactive.InteractiveShell.run()=console.interactive.InteractiveShell-class.html#run"><a title="console.interactive.InteractiveShell.run" class="py-name" href="#" onclick="return doclink('link-22', 'run', 'link-22');">run</a></tt><tt class="py-op">(</tt> <tt class="py-op">)</tt> </tt>
<a name="L608"></a><tt class="py-lineno">608</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="console-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/console/">console</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Tue Nov 30 11:33:30 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
